<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *     http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    package org.apache.commons.configuration.event;<a name="line.17"></a>
<FONT color="green">018</FONT>    <a name="line.18"></a>
<FONT color="green">019</FONT>    import java.util.EventObject;<a name="line.19"></a>
<FONT color="green">020</FONT>    <a name="line.20"></a>
<FONT color="green">021</FONT>    /**<a name="line.21"></a>
<FONT color="green">022</FONT>     * &lt;p&gt;<a name="line.22"></a>
<FONT color="green">023</FONT>     * An event class for reporting updates on a configuration object.<a name="line.23"></a>
<FONT color="green">024</FONT>     * &lt;/p&gt;<a name="line.24"></a>
<FONT color="green">025</FONT>     * &lt;p&gt;<a name="line.25"></a>
<FONT color="green">026</FONT>     * Event objects of this type are used for &amp;quot;raw&amp;quot; events, i.e.<a name="line.26"></a>
<FONT color="green">027</FONT>     * unfiltered modifications of any kind. A level with semantically higher events<a name="line.27"></a>
<FONT color="green">028</FONT>     * (e.g. for property changes) may be built on top of this fundamental event<a name="line.28"></a>
<FONT color="green">029</FONT>     * mechanism.<a name="line.29"></a>
<FONT color="green">030</FONT>     * &lt;/p&gt;<a name="line.30"></a>
<FONT color="green">031</FONT>     * &lt;p&gt;<a name="line.31"></a>
<FONT color="green">032</FONT>     * Each event can contain the following data:<a name="line.32"></a>
<FONT color="green">033</FONT>     * &lt;ul&gt;<a name="line.33"></a>
<FONT color="green">034</FONT>     * &lt;li&gt;A source object, which is usually the configuration object that was<a name="line.34"></a>
<FONT color="green">035</FONT>     * modified.&lt;/li&gt;<a name="line.35"></a>
<FONT color="green">036</FONT>     * &lt;li&gt;The event's type. This is a numeric value that corresponds to constant<a name="line.36"></a>
<FONT color="green">037</FONT>     * declarations in concrete configuration classes. It describes what exactly has<a name="line.37"></a>
<FONT color="green">038</FONT>     * happended.&lt;/li&gt;<a name="line.38"></a>
<FONT color="green">039</FONT>     * &lt;li&gt;If available, the name of the property whose modification caused the<a name="line.39"></a>
<FONT color="green">040</FONT>     * event.&lt;/li&gt;<a name="line.40"></a>
<FONT color="green">041</FONT>     * &lt;li&gt;If available, the value of the property that caused this event.&lt;/li&gt;<a name="line.41"></a>
<FONT color="green">042</FONT>     * &lt;li&gt;A flag whether this event was generated before or after the update of<a name="line.42"></a>
<FONT color="green">043</FONT>     * the source configuration. A modification of a configuration typically causes<a name="line.43"></a>
<FONT color="green">044</FONT>     * two events: one event before and one event after the modification is<a name="line.44"></a>
<FONT color="green">045</FONT>     * performed. This allows event listeners to react at the correct point of time.&lt;/li&gt;<a name="line.45"></a>
<FONT color="green">046</FONT>     * &lt;/ul&gt;<a name="line.46"></a>
<FONT color="green">047</FONT>     * &lt;/p&gt;<a name="line.47"></a>
<FONT color="green">048</FONT>     * &lt;p&gt;<a name="line.48"></a>
<FONT color="green">049</FONT>     * The following standard events are generated by typical configuration<a name="line.49"></a>
<FONT color="green">050</FONT>     * implementations (the constants for the event types are defined in<a name="line.50"></a>
<FONT color="green">051</FONT>     * {@link org.apache.commons.configuration.AbstractConfiguration}):<a name="line.51"></a>
<FONT color="green">052</FONT>     * &lt;dl&gt;<a name="line.52"></a>
<FONT color="green">053</FONT>     * &lt;dt&gt;EVENT_ADD_PROPERTY&lt;/dt&gt;<a name="line.53"></a>
<FONT color="green">054</FONT>     * &lt;dd&gt;This event is triggered for each call of the {@code addProperty()}<a name="line.54"></a>
<FONT color="green">055</FONT>     * method of a configuration object. It contains the name of the property, to<a name="line.55"></a>
<FONT color="green">056</FONT>     * which new data is added, and the value object that is added to this property<a name="line.56"></a>
<FONT color="green">057</FONT>     * (this may be an array or a list if multiple values are added).&lt;/dd&gt;<a name="line.57"></a>
<FONT color="green">058</FONT>     * &lt;dt&gt;EVENT_SET_PROPERTY&lt;/dt&gt;<a name="line.58"></a>
<FONT color="green">059</FONT>     * &lt;dd&gt;Calling the {@code setProperty()} method triggers this event. The<a name="line.59"></a>
<FONT color="green">060</FONT>     * event object stores the name of the affected property and its new value.&lt;/dd&gt;<a name="line.60"></a>
<FONT color="green">061</FONT>     * &lt;dt&gt;EVENT_CLEAR_PROPERTY&lt;/dt&gt;<a name="line.61"></a>
<FONT color="green">062</FONT>     * &lt;dd&gt;If a property is removed from a configuration (by calling the<a name="line.62"></a>
<FONT color="green">063</FONT>     * {@code clearProperty()} method), an event of this type is fired. In<a name="line.63"></a>
<FONT color="green">064</FONT>     * this case the event object only stores the name of the removed property, the<a name="line.64"></a>
<FONT color="green">065</FONT>     * value is &lt;b&gt;null&lt;/b&gt;.&lt;/dd&gt;<a name="line.65"></a>
<FONT color="green">066</FONT>     * &lt;dt&gt;EVENT_CLEAR&lt;/dt&gt;<a name="line.66"></a>
<FONT color="green">067</FONT>     * &lt;dd&gt;This event is fired when the whole configuration is cleared. The<a name="line.67"></a>
<FONT color="green">068</FONT>     * corresponding event object contains no additional data.&lt;/dd&gt;<a name="line.68"></a>
<FONT color="green">069</FONT>     * &lt;/dl&gt;<a name="line.69"></a>
<FONT color="green">070</FONT>     * &lt;/p&gt;<a name="line.70"></a>
<FONT color="green">071</FONT>     *<a name="line.71"></a>
<FONT color="green">072</FONT>     * @author &lt;a<a name="line.72"></a>
<FONT color="green">073</FONT>     * href="http://commons.apache.org/configuration/team-list.html"&gt;Commons<a name="line.73"></a>
<FONT color="green">074</FONT>     * Configuration team&lt;/a&gt;<a name="line.74"></a>
<FONT color="green">075</FONT>     * @version $Id: ConfigurationEvent.java 1207610 2011-11-28 21:06:22Z oheger $<a name="line.75"></a>
<FONT color="green">076</FONT>     * @since 1.3<a name="line.76"></a>
<FONT color="green">077</FONT>     */<a name="line.77"></a>
<FONT color="green">078</FONT>    public class ConfigurationEvent extends EventObject<a name="line.78"></a>
<FONT color="green">079</FONT>    {<a name="line.79"></a>
<FONT color="green">080</FONT>        /**<a name="line.80"></a>
<FONT color="green">081</FONT>         * The serial version UID.<a name="line.81"></a>
<FONT color="green">082</FONT>         */<a name="line.82"></a>
<FONT color="green">083</FONT>        private static final long serialVersionUID = 3277238219073504136L;<a name="line.83"></a>
<FONT color="green">084</FONT>    <a name="line.84"></a>
<FONT color="green">085</FONT>        /** Stores the event type. */<a name="line.85"></a>
<FONT color="green">086</FONT>        private int type;<a name="line.86"></a>
<FONT color="green">087</FONT>    <a name="line.87"></a>
<FONT color="green">088</FONT>        /** Stores the property name. */<a name="line.88"></a>
<FONT color="green">089</FONT>        private String propertyName;<a name="line.89"></a>
<FONT color="green">090</FONT>    <a name="line.90"></a>
<FONT color="green">091</FONT>        /** Stores the property value. */<a name="line.91"></a>
<FONT color="green">092</FONT>        private Object propertyValue;<a name="line.92"></a>
<FONT color="green">093</FONT>    <a name="line.93"></a>
<FONT color="green">094</FONT>        /** Stores the before update flag. */<a name="line.94"></a>
<FONT color="green">095</FONT>        private boolean beforeUpdate;<a name="line.95"></a>
<FONT color="green">096</FONT>    <a name="line.96"></a>
<FONT color="green">097</FONT>        /**<a name="line.97"></a>
<FONT color="green">098</FONT>         * Creates a new instance of {@code ConfigurationEvent} and<a name="line.98"></a>
<FONT color="green">099</FONT>         * initializes it.<a name="line.99"></a>
<FONT color="green">100</FONT>         *<a name="line.100"></a>
<FONT color="green">101</FONT>         * @param source the event source<a name="line.101"></a>
<FONT color="green">102</FONT>         * @param type the event's type<a name="line.102"></a>
<FONT color="green">103</FONT>         * @param propertyName the name of the affected property<a name="line.103"></a>
<FONT color="green">104</FONT>         * @param propertyValue the value of the affected property<a name="line.104"></a>
<FONT color="green">105</FONT>         * @param beforeUpdate the before update flag<a name="line.105"></a>
<FONT color="green">106</FONT>         */<a name="line.106"></a>
<FONT color="green">107</FONT>        public ConfigurationEvent(Object source, int type, String propertyName,<a name="line.107"></a>
<FONT color="green">108</FONT>                Object propertyValue, boolean beforeUpdate)<a name="line.108"></a>
<FONT color="green">109</FONT>        {<a name="line.109"></a>
<FONT color="green">110</FONT>            super(source);<a name="line.110"></a>
<FONT color="green">111</FONT>            this.type = type;<a name="line.111"></a>
<FONT color="green">112</FONT>            this.propertyName = propertyName;<a name="line.112"></a>
<FONT color="green">113</FONT>            this.propertyValue = propertyValue;<a name="line.113"></a>
<FONT color="green">114</FONT>            this.beforeUpdate = beforeUpdate;<a name="line.114"></a>
<FONT color="green">115</FONT>        }<a name="line.115"></a>
<FONT color="green">116</FONT>    <a name="line.116"></a>
<FONT color="green">117</FONT>        /**<a name="line.117"></a>
<FONT color="green">118</FONT>         * Returns the name of the affected property. This can be &lt;b&gt;null&lt;/b&gt; if no<a name="line.118"></a>
<FONT color="green">119</FONT>         * property change has lead to this event.<a name="line.119"></a>
<FONT color="green">120</FONT>         *<a name="line.120"></a>
<FONT color="green">121</FONT>         * @return the name of the property<a name="line.121"></a>
<FONT color="green">122</FONT>         */<a name="line.122"></a>
<FONT color="green">123</FONT>        public String getPropertyName()<a name="line.123"></a>
<FONT color="green">124</FONT>        {<a name="line.124"></a>
<FONT color="green">125</FONT>            return propertyName;<a name="line.125"></a>
<FONT color="green">126</FONT>        }<a name="line.126"></a>
<FONT color="green">127</FONT>    <a name="line.127"></a>
<FONT color="green">128</FONT>        /**<a name="line.128"></a>
<FONT color="green">129</FONT>         * Returns the value of the affected property if available.<a name="line.129"></a>
<FONT color="green">130</FONT>         *<a name="line.130"></a>
<FONT color="green">131</FONT>         * @return the value of the property; can be &lt;b&gt;null&lt;/b&gt;<a name="line.131"></a>
<FONT color="green">132</FONT>         */<a name="line.132"></a>
<FONT color="green">133</FONT>        public Object getPropertyValue()<a name="line.133"></a>
<FONT color="green">134</FONT>        {<a name="line.134"></a>
<FONT color="green">135</FONT>            return propertyValue;<a name="line.135"></a>
<FONT color="green">136</FONT>        }<a name="line.136"></a>
<FONT color="green">137</FONT>    <a name="line.137"></a>
<FONT color="green">138</FONT>        /**<a name="line.138"></a>
<FONT color="green">139</FONT>         * Returns the type of this event. This describes the update process that<a name="line.139"></a>
<FONT color="green">140</FONT>         * caused this event.<a name="line.140"></a>
<FONT color="green">141</FONT>         *<a name="line.141"></a>
<FONT color="green">142</FONT>         * @return the event's type<a name="line.142"></a>
<FONT color="green">143</FONT>         */<a name="line.143"></a>
<FONT color="green">144</FONT>        public int getType()<a name="line.144"></a>
<FONT color="green">145</FONT>        {<a name="line.145"></a>
<FONT color="green">146</FONT>            return type;<a name="line.146"></a>
<FONT color="green">147</FONT>        }<a name="line.147"></a>
<FONT color="green">148</FONT>    <a name="line.148"></a>
<FONT color="green">149</FONT>        /**<a name="line.149"></a>
<FONT color="green">150</FONT>         * Returns a flag if this event was generated before or after an update.<a name="line.150"></a>
<FONT color="green">151</FONT>         *<a name="line.151"></a>
<FONT color="green">152</FONT>         * @return &lt;b&gt;true&lt;/b&gt; if this event was generated before an update;<a name="line.152"></a>
<FONT color="green">153</FONT>         * &lt;b&gt;false&lt;/b&gt; otherwise<a name="line.153"></a>
<FONT color="green">154</FONT>         */<a name="line.154"></a>
<FONT color="green">155</FONT>        public boolean isBeforeUpdate()<a name="line.155"></a>
<FONT color="green">156</FONT>        {<a name="line.156"></a>
<FONT color="green">157</FONT>            return beforeUpdate;<a name="line.157"></a>
<FONT color="green">158</FONT>        }<a name="line.158"></a>
<FONT color="green">159</FONT>    }<a name="line.159"></a>




























































</PRE>
</BODY>
</HTML>
